@guidepup/guidepup
Advanced tools
Screen-reader driver for automation.
Providing a reliable set of APIs to automate your screen-reader a11y workflows through JavaScript.
Setup your environment for screen-reader automation with @guidepup/setup:
npx @guidepup/setup
Install Guidepup to your project:
npm install @guidepup/guidepup
And get cracking with your first screen-reader automation code! 🚀
import { VoiceOver } from "@guidepup/guidepup";
async function run(): Promise<void> {
// Construct and start your screen-reader instance 🎉
const vo = new VoiceOver();
await vo.start();
// Navigate your environment with screen-readers just as your users do 🏎
await vo.moveNext();
// Assert on what your users really see and hear when using screen-readers 👂
console.log(await vo.getLastSpokenPhrase());
await vo.stop();
}
run();
Check out these fab guides on how to set up your local or CI environments for using Guidepup.
Check out these awesome examples to learn how you could use Guidepup in your projects.
The API documentation has all the information you need to write fantastic screen-reader driven workflows.
Check out some of the other Guidepup modules:
Screen-reader support:
Environment support:
Building on the shoulders of giants! 🙌
Here are some related projects:
FAQs
Screen reader driver for test automation.
The npm package @guidepup/guidepup receives a total of 2,933 weekly downloads. As such, @guidepup/guidepup popularity was classified as popular.
We found that @guidepup/guidepup demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Company News
Socket is joining TC54 to help develop standards for software supply chain security, contributing to the evolution of SBOMs, CycloneDX, and Package URL specifications.
Security News
PyPI now allows maintainers to archive projects, improving security and helping users make informed decisions about their dependencies.
Research
Security News
Malicious npm package postcss-optimizer delivers BeaverTail malware, targeting developer systems; similarities to past campaigns suggest a North Korean connection.